<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>pod2html - convert .pod files to .html files - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/pod2html">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="pod2html.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/pod2html">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/pod2html">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/pod2html">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/pod2html">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/pod2html">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/pod2html">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/pod2html">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/pod2html">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/pod2html">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/pod2html">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/pod2html">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/pod2html">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/pod2html">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/pod2html">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/pod2html">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/pod2html">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/pod2html">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/pod2html">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/pod2html">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/pod2html">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/pod2html">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/pod2html">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/pod2html">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/pod2html">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/pod2html">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/pod2html">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/pod2html">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/pod2html">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/pod2html">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/pod2html">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/pod2html">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/pod2html">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/pod2html">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/pod2html">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/pod2html">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/pod2html">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/pod2html">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/pod2html">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/pod2html">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/pod2html">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/pod2html">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/pod2html">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/pod2html">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/pod2html">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/pod2html">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/pod2html">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/pod2html">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/pod2html">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/pod2html">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/pod2html">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/pod2html">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/pod2html">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/pod2html">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/pod2html">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/pod2html">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/pod2html">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/pod2html">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/pod2html">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/pod2html">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/pod2html">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/pod2html">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/pod2html">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/pod2html">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/pod2html">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/pod2html">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/pod2html">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/pod2html">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/pod2html">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/pod2html">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/pod2html">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/pod2html">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/pod2html">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/pod2html">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/pod2html">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/pod2html">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/pod2html">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/pod2html">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/pod2html">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/pod2html">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/pod2html">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="pod2html.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/pod2html">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/pod2html">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/pod2html">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/pod2html">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/pod2html">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/pod2html">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/pod2html">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/pod2html">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/pod2html">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/pod2html">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/pod2html">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/pod2html">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/pod2html">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/pod2html">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/pod2html">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/pod2html">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/pod2html">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/pod2html">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/pod2html">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/pod2html">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/pod2html">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/pod2html">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/pod2html">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/pod2html">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/pod2html">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/pod2html">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/pod2html">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/pod2html">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/pod2html">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/pod2html">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/pod2html">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/pod2html">5.35.1</a>
          <a class="dropdown-item active" href="pod2html.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="pod2html.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="pod2html.html">pod2html</a>
          <div id="more">
            (<a href="pod2html.txt">source</a>,
            <a href="https://metacpan.org/pod/pod2html">CPAN</a>)
          </div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="pod2html.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#ARGUMENTS">ARGUMENTS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#AUTHOR">AUTHOR</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#BUGS">BUGS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#SEE-ALSO">SEE ALSO</a>
              </li>
              <li>
                <a class="text-decoration-none" href="pod2html.html#COPYRIGHT">COPYRIGHT</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="pod2html.html#NAME">#</a>NAME</h1>

<p>pod2html - convert .pod files to .html files</p>

<h1 id="SYNOPSIS"><a class="permalink" href="pod2html.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code class="plaintext">pod2html --help --htmldir=&lt;name&gt; --htmlroot=&lt;URL&gt;
         --infile=&lt;name&gt; --outfile=&lt;name&gt;
         --podpath=&lt;name&gt;:...:&lt;name&gt; --podroot=&lt;name&gt;
         --cachedir=&lt;name&gt; --flush --recurse --norecurse
         --quiet --noquiet --verbose --noverbose
         --index --noindex --backlink --nobacklink
         --header --noheader --poderrors --nopoderrors
         --css=&lt;URL&gt; --title=&lt;name&gt;</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="pod2html.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>Converts files from pod format (see <a href="perlpod.html">perlpod</a>) to HTML format.</p>

<h1 id="ARGUMENTS"><a class="permalink" href="pod2html.html#ARGUMENTS">#</a>ARGUMENTS</h1>

<p>pod2html takes the following arguments:</p>

<dl>

<dt id="help"><a class="permalink" href="pod2html.html#help">#</a>help</dt>
<dd>

<pre><code class="plaintext">--help</code></pre>

<p>Displays the usage message.</p>

</dd>
<dt id="htmldir"><a class="permalink" href="pod2html.html#htmldir">#</a>htmldir</dt>
<dd>

<pre><code class="plaintext">--htmldir=name</code></pre>

<p>Sets the directory to which all cross references in the resulting HTML file will be relative. Not passing this causes all links to be absolute since this is the value that tells Pod::Html the root of the documentation tree.</p>

<p>Do not use this and --htmlroot in the same call to pod2html; they are mutually exclusive.</p>

</dd>
<dt id="htmlroot"><a class="permalink" href="pod2html.html#htmlroot">#</a>htmlroot</dt>
<dd>

<pre><code class="plaintext">--htmlroot=URL</code></pre>

<p>Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.</p>

<p>Do not use this if relative links are desired: use --htmldir instead.</p>

<p>Do not pass both this and --htmldir to pod2html; they are mutually exclusive.</p>

</dd>
<dt id="infile"><a class="permalink" href="pod2html.html#infile">#</a>infile</dt>
<dd>

<pre><code class="plaintext">--infile=name</code></pre>

<p>Specify the pod file to convert. Input is taken from STDIN if no infile is specified.</p>

</dd>
<dt id="outfile"><a class="permalink" href="pod2html.html#outfile">#</a>outfile</dt>
<dd>

<pre><code class="plaintext">--outfile=name</code></pre>

<p>Specify the HTML file to create. Output goes to STDOUT if no outfile is specified.</p>

</dd>
<dt id="podroot"><a class="permalink" href="pod2html.html#podroot">#</a>podroot</dt>
<dd>

<pre><code class="plaintext">--podroot=name</code></pre>

<p>Specify the base directory for finding library pods.</p>

</dd>
<dt id="podpath"><a class="permalink" href="pod2html.html#podpath">#</a>podpath</dt>
<dd>

<pre><code class="plaintext">--podpath=name:...:name</code></pre>

<p>Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.</p>

</dd>
<dt id="cachedir"><a class="permalink" href="pod2html.html#cachedir">#</a>cachedir</dt>
<dd>

<pre><code class="plaintext">--cachedir=name</code></pre>

<p>Specify which directory is used for storing cache. Default directory is the current working directory.</p>

</dd>
<dt id="flush"><a class="permalink" href="pod2html.html#flush">#</a>flush</dt>
<dd>

<pre><code class="plaintext">--flush</code></pre>

<p>Flush the cache.</p>

</dd>
<dt id="backlink"><a class="permalink" href="pod2html.html#backlink">#</a>backlink</dt>
<dd>

<pre><code class="plaintext">--backlink</code></pre>

<p>Turn =head1 directives into links pointing to the top of the HTML file.</p>

</dd>
<dt id="nobacklink"><a class="permalink" href="pod2html.html#nobacklink">#</a>nobacklink</dt>
<dd>

<pre><code class="plaintext">--nobacklink</code></pre>

<p>Do not turn =head1 directives into links pointing to the top of the HTML file (default behaviour).</p>

</dd>
<dt id="header"><a class="permalink" href="pod2html.html#header">#</a>header</dt>
<dd>

<pre><code class="plaintext">--header</code></pre>

<p>Create header and footer blocks containing the text of the &quot;NAME&quot; section.</p>

</dd>
<dt id="noheader"><a class="permalink" href="pod2html.html#noheader">#</a>noheader</dt>
<dd>

<pre><code class="plaintext">--noheader</code></pre>

<p>Do not create header and footer blocks containing the text of the &quot;NAME&quot; section (default behaviour).</p>

</dd>
<dt id="poderrors"><a class="permalink" href="pod2html.html#poderrors">#</a>poderrors</dt>
<dd>

<pre><code class="plaintext">--poderrors</code></pre>

<p>Include a &quot;POD ERRORS&quot; section in the outfile if there were any POD errors in the infile (default behaviour).</p>

</dd>
<dt id="nopoderrors"><a class="permalink" href="pod2html.html#nopoderrors">#</a>nopoderrors</dt>
<dd>

<pre><code class="plaintext">--nopoderrors</code></pre>

<p>Do not include a &quot;POD ERRORS&quot; section in the outfile if there were any POD errors in the infile.</p>

</dd>
<dt id="index"><a class="permalink" href="pod2html.html#index">#</a>index</dt>
<dd>

<pre><code class="plaintext">--index</code></pre>

<p>Generate an index at the top of the HTML file (default behaviour).</p>

</dd>
<dt id="noindex"><a class="permalink" href="pod2html.html#noindex">#</a>noindex</dt>
<dd>

<pre><code class="plaintext">--noindex</code></pre>

<p>Do not generate an index at the top of the HTML file.</p>

</dd>
<dt id="recurse"><a class="permalink" href="pod2html.html#recurse">#</a>recurse</dt>
<dd>

<pre><code class="plaintext">--recurse</code></pre>

<p>Recurse into subdirectories specified in podpath (default behaviour).</p>

</dd>
<dt id="norecurse"><a class="permalink" href="pod2html.html#norecurse">#</a>norecurse</dt>
<dd>

<pre><code class="plaintext">--norecurse</code></pre>

<p>Do not recurse into subdirectories specified in podpath.</p>

</dd>
<dt id="css"><a class="permalink" href="pod2html.html#css">#</a>css</dt>
<dd>

<pre><code class="plaintext">--css=URL</code></pre>

<p>Specify the URL of cascading style sheet to link from resulting HTML file. Default is none style sheet.</p>

</dd>
<dt id="title"><a class="permalink" href="pod2html.html#title">#</a>title</dt>
<dd>

<pre><code class="plaintext">--title=title</code></pre>

<p>Specify the title of the resulting HTML file.</p>

</dd>
<dt id="quiet"><a class="permalink" href="pod2html.html#quiet">#</a>quiet</dt>
<dd>

<pre><code class="plaintext">--quiet</code></pre>

<p>Don&#39;t display mostly harmless warning messages.</p>

</dd>
<dt id="noquiet"><a class="permalink" href="pod2html.html#noquiet">#</a>noquiet</dt>
<dd>

<pre><code class="plaintext">--noquiet</code></pre>

<p>Display mostly harmless warning messages (default behaviour). But this is not the same as &quot;verbose&quot; mode.</p>

</dd>
<dt id="verbose"><a class="permalink" href="pod2html.html#verbose">#</a>verbose</dt>
<dd>

<pre><code class="plaintext">--verbose</code></pre>

<p>Display progress messages.</p>

</dd>
<dt id="noverbose"><a class="permalink" href="pod2html.html#noverbose">#</a>noverbose</dt>
<dd>

<pre><code class="plaintext">--noverbose</code></pre>

<p>Do not display progress messages (default behaviour).</p>

</dd>
</dl>

<h1 id="AUTHOR"><a class="permalink" href="pod2html.html#AUTHOR">#</a>AUTHOR</h1>

<p>Tom Christiansen, &lt;tchrist@perl.com&gt;.</p>

<h1 id="BUGS"><a class="permalink" href="pod2html.html#BUGS">#</a>BUGS</h1>

<p>See <a href="./Pod::Html.html">Pod::Html</a> for a list of known bugs in the translator.</p>

<h1 id="SEE-ALSO"><a class="permalink" href="pod2html.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="perlpod.html">perlpod</a>, <a href="./Pod::Html.html">Pod::Html</a></p>

<h1 id="COPYRIGHT"><a class="permalink" href="pod2html.html#COPYRIGHT">#</a>COPYRIGHT</h1>

<p>This program is distributed under the Artistic License.</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
